Returns/sets whether or not runtime user changes are allowed.

Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 — Flat or 1 — 3D. Default is 0 — Flat.

Returns/sets the background color override.

Enables/disables blinking of the icon on unacknowledged alarms.

Enables/disables blinking of the leftmost textual column on unacknowledged alarms.

Enables/disables blinking of unacknowledged alarms.

BorderStyle specifies the border style of the object boundary.

Most tools use one of these sets of options:

• 0 — ibsNone, 1 — ibsRaised, or 2 — ibsLowered, and the default is 0 — ibsNone

• 0 — None or 1 — Fixed Single, and the default is 0 — None

The Panel Switch Tool uses these options:

• 0 — ibsLine, 1 — ibsRaised, 2 — ibsLowered, 3 — ibsTop, and 4 — ibsNone, and the default is 0 — ibsLine.

For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are:

• 0 — Normal, 1 — 3D, 2 — Sunken, 3 — Raised, and 4 — None

The default for the Box Tool is 0 — Normal. The default for the Frame Tool is 1 — 3D. The default for the Text Tool is 4 — None.

If you use 2 — Sunken or 3 — Raised and the effect is not visible, change the object’s HiliteColor.

If you use 0 — Normal, 2 — Sunken, or 3 — Raised, you can set the border width using the PenWidth property.

For TheFrame/TheView, the BorderStyle property specifies both the style of the object's border and whether the object can be resized by the user in Run mode. The default is 0 — Thin, which means the border is thin and the size is static. The other possible option is 1 — Resizing, which means the border is thicker and can be resized.

See also Appearance.

Script subtype is integer.

Bottom specifies the distance (in pixels) from the top of TheView’s scroll region to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object. See Sizing and Positioning Objects.

Enables/disables the first buttons column.

Returns/sets the action associated with clicking a button in the first buttons column. Possible values for this property are:

• 0 — Acknowledge alarm
• 1 — Launch Alarm Suppression Settings dialog
• 2 — Hide alarm
• 3 — Clear alarm
• 4 — Launch Alarm History dialog box
• 5 — Launch a Point Properties dialog box
• 6 — Fires the OnButtonClick event.

Returns/sets the button text for the first buttons column.

Enables/disables the last buttons column.

Returns/sets the action associated with clicking a button in the last buttons column. Possible values for this property are:

• 0 — Acknowledge alarm
• 1 — Launch Alarm Suppression Settings dialog box
• 2 — Hide alarm
• 3 — Clear alarm
• 4 — Launch Alarm History dialog box
• 5 — Launch Point Properties dialog box
• 6 — Fires the OnSecondButtonClick event.

Returns/sets the button text for the last buttons column.

Returns/sets the XML representing the descriptions of custom attributes.

Returns/sets the XML representing the values of custom attributes.

Returns/sets the color mode (0 — single color mode, 1 — dual color mode).

Specifies the number of columns that are defined for the object or the XML that represents the list of displayed columns. Use the OCX Properties dialog box to select.

For a WatchList Tool, Columns specifies the identifier of each column. Items are semicolon separated.

ContextMenuXml identifies an XML string that defines the contents and Event IDs for the object’s custom context menu. See Custom Context Menus for more information about configuring custom menus for ActiveX Controls.

ActiveX Control Example

The following example includes one new menu item (New Item).

1
2
3
4
5
6
7
8
9
10
<CustomContextMenu>
    <items>
        <ContextMenuDef>
            <itemsHidden/>
            <items>
                    <MenuItem Disable1="false" Disable2="false" Disable3="false" Description="New Context Menu Item (at bottom)" EventID="NEWID"/>
            </items>
        </ContextMenuDef>
    </items>
</CustomContextMenu>

CAS View Control Example

The CAS View Control includes additional options to hide default menu items. The following example includes one new menu item (New Item) and one hidden item (Suppress…). See CAS View Control.

1
2
3
4
5
6
7
8
9
10
11
12
<CustomContextMenu>
    <items>
        <ContextMenuDef>
            <itemsHidden>
                <DefaultMenuItem MenuId="1021" Desc="Suppress..." Type="0"/>
            </itemsHidden>
            <items>
                <MenuItem Disable1="true" Disable2="false" Disable3="false" Description="New Item" EventID="NEWID"/>
            </items>
        </ContextMenuDef>
    </items>
</CustomContextMenu>

For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects.

For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer.

The default is 0 — Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:

• 1 — Arrow
• 2 — IBeam
• 3 — Cross
• 4 — UpArrow
• 5 — NoDrop
• 6 — Help
• 99 — HotSpot
• 100 — Timer

Script subtype is long.

Returns/sets the icon color mode (False — foreground color, True — background color).

Returns/sets whether or not double-clicking a row will launch a Point Properties dialog box.

Returns/sets the empty space color override. The empty space is the area to the right and below the CAS View Control grid.

Enable specifies whether the user is able to interact with the object. Options are 0 — No and 1 — Yes. The default is 1 — Yes. If set to 0 — No, the object is still visible but its context menu is disabled.

Other options:

• Completely hide the object in run mode using the Visible property.
• Display the object but hide its [DisplayItem] using the [DisplayElement] property.

Specifies the XML representing the alarm filter.

FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:

• 0 — None (no resizing occurs)
• 1 — Shift (the object is shifted)
• 2 — Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 — Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 — None.

FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:

• 0 — None (no resizing occurs)
• 1 — Shift (the object is shifted)
• 2 — Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 — Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 — None.

Returns/sets the focus rectangle color.

Returns/sets the focus rectangle border width.

Font specifies the font for the object.

For TheView, this property specifies the default font for text-based objects.

For other objects, it specifies the font for the instance of the object. The object’s font takes precedence over the font set for TheView.

Click … to view the Font dialog box, which you can use to configure the font. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string.

Returns/sets the foreground override color.

Group groups objects into a discrete sequence that can be navigated using the arrow keys.

Options are 0 — No and 1 — Yes. The default is 0 — No.

To use this property:

1. Add objects that use the Group property to a screen.

2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen).

3. Decide where in the spatial configuration logical groups begin and end.

4. Mark the beginning of a group by setting the Group property to 1 — Yes for the first object in the group.

5. Set Group set to 0 — No for other objects in the group.

The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 — Yes and 2) that use a Group property set to 0 — No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen.

This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property.

Script subtype is long.

See also Tabstop.

HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled.

Script subtype is long.

Returns/sets the path to the custom Acknowledged icon.

Returns/sets the path to the custom Out-of-Service icon.

Returns/sets the path to the custom Unacknowledged icon.

Returns/sets the path to the custom Unknown icon.

Layer identifies the layer on which the object resides. Script subtype is Boolean.

Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object. See Sizing and Positioning Objects.

(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string.

Displays the OCXProperty dialog box unique to the object.

Enables/disables background color override.

Enables/disables text color override.

Enables/disables empty space color override. The empty space is the area to the right and below the CAS View Control grid.

Enables/disables focus color override.

Enables/disables foreground color override.

Returns/sets the XML representing the grid properties.

Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object. See Sizing and Positioning Objects.

Returns/sets the default row height.

Returns/sets the multi-selection background color.

Returns/sets the multi-selection foreground color.

Enables/disables grid lines.

Enables/disables alarm icon visibility.

Enables/disables entire row alarm coloring (i.e. if this property is set to True, the entire row will be shown in the row’s alarm color).

Returns/sets the semicolon-delimited list of CAS Site.Services.

Returns/sets the XML representing the default sorting mode.

Enables/disables runtime sorting.

Returns/sets the XML representing the sound configuration.

Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is long.

See also Group and Tab Order.

Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string.

Returns/sets the tokenized tooltip string.

Top specifies the distance (in pixels) from the top of TheView’s scroll region to the top of the object. See Sizing and Positioning Objects.

Enables/disables the custom Acknowledged icon.

Enables/disables the custom Out-of-Service icon.

Enables/disables the custom Unacknowledged icon.

Enables/disables the custom Unknown icon.

Visible secifies whether the object is visible in Run mode. Options are 0 — No or 1 — Yes. Default is 1 — Yes.

You can also:

• Display the object but hide its [DisplayItem] using the [DisplayElement] property.
• Show both the object and its [DisplayItem] but disable user interaction using the Enable property.
• Hide the object if the point does not exist using the [UnknownTag].